package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SubsidyInfoAddDTO;
import org.jsola.hr.dto.SubsidyInfoUpdateDTO;
import org.jsola.hr.query.SubsidyInfoQuery;
import org.jsola.hr.vo.SubsidyInfoListVO;
import org.jsola.hr.vo.SubsidyInfoVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-员工津贴信息")
public interface ISubsidyInfoControllerAPI {

    /**
     * 新增员工津贴信息
     * @param subsidyInfoAddDTO 员工津贴信息新增实体
     * @return 员工津贴信息展示对象
     */
    @ApiOperation(value = "新增员工津贴信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "subsidyInfoAddDTO", dataType = "SubsidyInfoAddDTO", value = "新增员工津贴信息", paramType = "body")
    })
    Result<SubsidyInfoVO> save(SubsidyInfoAddDTO subsidyInfoAddDTO);


    /**
     * 修改员工津贴信息
     * @param subsidyInfoUpdateDTO 员工津贴信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工津贴信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "subsidyInfoUpdateDTO", dataType = "SubsidyInfoUpdateDTO", value = "修改员工津贴信息", paramType = "body")
    })
    Result<Integer> update(SubsidyInfoUpdateDTO subsidyInfoUpdateDTO);




    /**
     * 删除单个员工津贴信息，彻底删除
     * @param subsidyInfoId 员工津贴信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工津贴信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "subsidyInfoId", dataType = "String", value = "员工津贴信息id", paramType = "path")
    })
    Result<Integer> delete(String subsidyInfoId);


    /**
     * 批量删除员工津贴信息，彻底删除
     * @param subsidyInfoIds 员工津贴信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工津贴信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "subsidyInfoIds", dataType = "String[]", value = "员工津贴信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] subsidyInfoIds);


    /**
     * 根据员工津贴信息id查询员工津贴信息详情
     * @param subsidyInfoId 员工津贴信息id
     * @return 员工津贴信息详情
     */
    @ApiOperation(value="根据员工津贴信息id查询员工津贴信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "subsidyInfoId", dataType = "String", value = "员工津贴信息id", paramType = "path")
    })
    Result<SubsidyInfoVO> findById(String subsidyInfoId);


    /**
     * 查询员工津贴信息
     * @param subsidyInfoQuery 员工津贴信息查询参数
     * @return page
     */
    @ApiOperation(value="查询员工津贴信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "subsidyInfoQuery", dataType = "SubsidyInfoQuery", value = "员工津贴信息查询参数", paramType = "query")
    })
    Result<List<SubsidyInfoListVO>> listAll(SubsidyInfoQuery subsidyInfoQuery);


     /**
     * 分页查询员工津贴信息
     * @param subsidyInfoQuery 员工津贴信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工津贴信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "subsidyInfoQuery", dataType = "SubsidyInfoQuery", value = "员工津贴信息查询参数", paramType = "query")
    })
    Result<Page<SubsidyInfoListVO>> page(SubsidyInfoQuery subsidyInfoQuery);


}

